home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / system / obskit15.zip / QUIKSTRT.DOC < prev    next >
Text File  |  1992-01-11  |  21KB  |  528 lines
  1.                          Obs Toolkit Version 1.5
  2.  
  3.                              Contrails, Inc.
  4.                               P.O. Box 2759
  5.                             Lompoc, CA 93438
  6.  
  7.                              (805) 733-2808
  8.  
  9.  
  10.                               Introduction
  11.                               ------------
  12.  
  13. Welcome to Obs Toolkit. We thank you for your interest. The OBSKIT.DOC is
  14. a large file with a all of the detailed information. We recommend that
  15. you read it. This file is provided to get you up and running with a
  16. minimum of hassel.
  17.  
  18. The information in this file, should introduce you to the Toolkit, and
  19. get you interested in no time.
  20.  
  21. Obs Toolkit requires DOS 3.0 or higher and 256Kb of memory. Obs Toolkit
  22. is complementary to all versions of DOS including DOS 5.
  23.  
  24.  
  25.                                 Overview
  26.                                 --------
  27.  
  28. This guide is structured to describe the tools; give you a taste of the
  29. Toolkits capabilities and describe some terms and interfaces.
  30.  
  31.  
  32.                              Supplied Files
  33.                              --------------
  34.  
  35. The files that make up Obs Tools are:
  36.    o ALIAS.EXE    - Alias, the alias generator
  37.    o DIRSTACK.COM - A directory stack without Alias translator
  38.    o DS.EXE       - DirSize, a tree with sizes
  39.    o EE.EXE       - EnvEdit, a DOS environment editor
  40.    o FD.EXE       - FileDump, the file viewer
  41.    o LF.EXE       - ListFiles, the file lister
  42.    o LOCATE.EXE   - Locate, the executable command and file locator
  43.    o MF.EXE       - MultiFile, the file manipulator
  44.    o OBSRES.COM   - Alias translator, dictionary, and directory stack
  45.    o OCD.EXE      - ObsCD, a super-intelligent Change Directory
  46.    o RERES.COM    - Recapture the command line
  47.  
  48. The files with alias definitions are:
  49.    o ALIASES.DOS  - Replaces DOS internal commands
  50.    o ALIASES.REC  - A comprehensive set of recursive aliases
  51.  
  52.    o xDOS.CFG     - Aliases for NDOS and 4DOS users
  53.    o PCED.CFG     - Aliases for PCED users
  54.    o CMD_ED.CFG   - Aliases for CMDEDIT users
  55.  
  56. Support files are:
  57.    o INSTALL.BAT  - Automatic installation into your AUTOEXEC.BAT
  58.    o TRYIT.BAT    - Quick Start batch file, to get you up and running
  59.  
  60.    o OBSKIT.DOC   - Obs Toolkit users manual
  61.    o QUIKSTRT.DOC - This file (introduction, orientation, quick start)
  62.    o README.DOC   - Startup advice
  63.    o REGISTER.DOC - Registration form
  64.    o UPDATES.DOC  - Changes since version 1.0
  65.    o UPGRADE.DOC  - Notes for users of version 1.0
  66.  
  67.  
  68.                           Toolkit Capabilities
  69.                           --------------------
  70.  
  71. The Toolkits sole purpose is to give you, the user, POWER! No, it won't
  72. generate electricity, but it will allow you to do things at the command
  73. line, or in batch files, that were never before possible.
  74.  
  75. Obs Toolkit can be used to generate your own commands! Obs Toolkit can
  76. provide custom commands, like (this is by no means an exhaustive set):
  77.  
  78.    o ALIAS  (define your own commands)
  79.    o ATTRIB (set and/or clear any DOS attributes)
  80.    o CD     (fuzzy matching, across disks, push, pop, up)
  81.    o COPY   (add, update, replace, add & update, archive only)
  82.    o DELETE (files, directories with contents)
  83.    o DIR    (any sort, duplicates, old files, identical contents)
  84.    o LOCATE (commands, files, multiple disks)
  85.    o MOVE   (between directories, across disks, whole directories)
  86.    o RENAME (files, directories)
  87.    o SET    (any environment, editor, long variables, batchable)
  88.    o TOUCH  (set file date and time to any valid timestamp)
  89.    o TREE   (with directory sizes, creation dates)
  90.    o TYPE   (ASCII only, HEX dump, strings, counts, multiple files)
  91.  
  92. Obs Toolkit can be used within batch files. Each tool returns an
  93. errorlevel, and a few tools have options specifically tailored for batch
  94. use.
  95.  
  96. The errorlevels generated are:
  97.  
  98.   0 - NO ERROR         - No error encountered
  99.   1 - NOT FOUND        - File or object was "NOT FOUND"
  100.   2 - ABORTED          - The user chose to "ABORT" the operation
  101.   3 - OPERATION FAILED - The requested "OPERATION FAILED"
  102.   4 - LIMIT EXCEEDED   - The operation exceeded the tools "LIMIT"
  103.   5 - USAGE ERROR      - The tool displayed a "USAGE" error
  104.   6 - INSTALL FAILED   - The tool was unable to "INSTALL"
  105.  
  106.  
  107.                            Quick Installation
  108.                            ------------------
  109. A quick installation patch is provided so that trying out the Toolkit is
  110. completely painless. This is a description of that installation process:
  111.  
  112. The way to get started running Obs Toolkit right now, is to move to the
  113. directory where the Toolkit is located and type:
  114.  
  115.   C> TRYIT
  116.  
  117.   NOTE: NDOS and 4DOS users
  118.     OBSRES will not be able to swap the command line. You should use the
  119.     XDOS.CFG file. Instead of installing OBSRES install only a DirStack
  120.     using DIRSTACK 9 to minimize the memory consumption.
  121.  
  122. TRYIT.BAT will only map the existing DOS commands to Toolkit equivalents.
  123. The Toolkit has much more power than what is shown below. The TRYIT.BAT
  124. is just providing a taste.
  125.                     ~~~~~
  126. Replaced Commands
  127. -----------------
  128. Obs Toolkit will be installed into memory (takes up 3K RAM) and will
  129. supplant the following DOS commands:
  130.   o CD, CHDIR   - mapped to ObsCD     (OCD)
  131.   o COPY        - mapped to MultiFile (MF)
  132.   o DEL, ERASE  - mapped to MultiFile (MF)
  133.   o DIR         - mapped to ListFiles (LF)
  134.   o MD, MKDIR   - mapped to ObsCD     (OCD)
  135.   o PATH        - mapped to EnvEdit   (EE)
  136.   o PROMPT      - mapped to EnvEdit   (EE)
  137.   o RD, RMDIR   - mapped to ObsCD     (OCD)
  138.   o REN, RENAME - mapped to MultiFile (MF)
  139.   o SET         - mapped to EnvEdit   (EE)
  140.   o TYPE        - mapped to FileDump  (FD)
  141.  
  142.  
  143. Building a HotDir file
  144. ----------------------
  145. To enable HotDir support for changing directories type:
  146.  
  147.   C> OCD /READ
  148.  
  149. This will scan all disks and remember the locations of all directories.
  150.  
  151. If you have RAM disks, network drives, or any directories that you don't
  152. want to include in the HotDir file, then refer to the Users Manual for
  153. the commands to tailor the HotDir file to your liking. ObsCD is real
  154. agreeable.
  155.  
  156.  
  157. Turning the Toolkit ON and OFF
  158. ------------------------------
  159. When you run TRYIT.BAT the Toolkit is ON. You can switch the Toolkit ON
  160. and OFF by using the DOT COMMANDS (.command) at the DOS prompt.
  161.  
  162. The .COMMANDS available are:
  163.   .ON     - Turn the Toolkit ON
  164.   .OFf    - Turn the Toolkit OFF
  165.   .Echo   - Display ALIAS translations
  166.   .Noecho - Do not display ALIAS translations
  167.  
  168. You can also skip an alias translation by prefixing the command with a
  169. space (ALIAS can change the Skip Character):
  170.  
  171.   C>DIR  (uses the alias)
  172.   C> DIR (uses DOS)
  173.  
  174.  
  175.                          Persistent Installation
  176.                          -----------------------
  177. This installation will modify your AUTOEXEC.BAT file so that the Toolkit
  178. interface will be available each time you boot your computer.
  179.  
  180. The commands provided are documented in the ALIASES.REC file.
  181.  
  182. A new file will be created in the Toolkit directory (ALIASES.FIL) which
  183. contains the aliases from ALIASES.REC and has the OB alias defined.
  184.  
  185. The AUTOEXEC.BAT file will be modified (appended to) to contain:
  186.   [obs_path]\OBSRES
  187.   [obs_path]\ALIAS /FILE [obs_path]\ALIASES.FIL
  188.  
  189. To perform the persistent installation you must:
  190.   1) Change to the directory where the Toolkit is located
  191.   2) Type "INSTALL" at the command line
  192.  
  193. INSTALL.BAT is providing you with a full seven course meal!
  194.                                          ~~~~~ ~~~~~~ ~~~~
  195. If you haven't already done a HotDir scan (OCD /READ) and you want OCD
  196. HotDir support then refer to the section "Building a HotDir File" above.
  197.  
  198. You may want to edit your AUTOEXEC.BAT file to add the Toolkit directory
  199. to your path (this is required for batch file support unless you use
  200. fully qualified filenames).
  201.  
  202. If your AUTOEXEC.BAT launches a menu program (or Windows) you must
  203. manually move the two Toolkit commands before the menu program commands
  204. or the Toolkit interface will not be available until after you exit the
  205. menu program.
  206.  
  207.  
  208.